<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }

                .term {
                        font: italic 16px verdana, sans-serif;
                        font-weight: normal;
                }

                .type {
                        font: normal 16px verdana, sans-serif !important;
                }

                .parameter {
                        font-style: italic;
                        }

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
                        padding-top: 10px;
                        padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }

                span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }

        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }

        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
                        margin-top: 10px;
            background-color: #FFF;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
                        font: normal 16px verdana, sans-serif;
        }

        div.refsect1 th {
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }

        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
                        border-collapse: collapse;
                        border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }

                  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }


        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
                        white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }

</style>
    <title>clEnqueueMigrateMemObjects</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <meta name="keywords" content="clEnqueueMigrateMemObjects" />
  </head>
  <body>
    <div class="refentry">
      <a id="id-1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <a xmlns="http://www.w3.org/1999/xhtml" id="clEnqueueMigrateMemObjects"></a>
        <h1>
            clEnqueueMigrateMemObjects
        </h1>
        <p>
            Enqueues a command to indicate which device a set of memory objects should be associated with.
        </p>
      </div>
      <div class="refsynopsisdiv">
        <h2></h2>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    <a class="link" href="scalarDataTypes.html" target="pagedisplay">cl_int</a>
                    <strong class="fsfunc">clEnqueueMigrateMemObjects </strong>
                (</code>
                <td>
                        <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_command_queue</a>
                         <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">command_queue</var>
                    , </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>
                        <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_uint</a>
                         <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_mem_objects</var>
                    , </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>const
                        <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_mem</a>
                         <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*mem_objects</var>
                    , </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>
                        <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_mem_migration_flags" target="pagedisplay">cl_mem_migration_flags</a>
                         <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">flags</var>
                    , </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>
                        <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="pagedisplay">cl_uint</a>
                         <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_events_in_wait_list</var>
                    , </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>const
                        <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_event</a>
                         <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*event_wait_list</var>
                    , </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td>
                        <a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="pagedisplay">cl_event</a>
                         <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*event</var>
                    <code>)</code></td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="parameters"></a>
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term"> <code class="varname"> command_queue </code> </span>
            </dt>
            <dd>
              <p>
                      A valid command-queue. The specified set of memory objects in
                      <code class="varname">mem_objects</code> will be migrated to the OpenCL device
                      associated with <code class="varname">command_queue</code> or to the host if the
                      <code class="constant">CL_MIGRATE_MEM_OBJECT_HOST</code> has been specified.
                    </p>
            </dd>
            <dt>
              <span class="term"> <code class="varname"> num_mem_objects </code> </span>
            </dt>
            <dd>
              <p>
                        The number of memory objects specified in <code class="varname">mem_objects</code>.
                    </p>
            </dd>
            <dt>
              <span class="term"> <code class="varname"> mem_objects </code> </span>
            </dt>
            <dd>
              <p>
                        A pointer to a list of memory objects.
                    </p>
            </dd>
            <dt>
              <span class="term"> <code class="varname"> flags </code> </span>
            </dt>
            <dd>
              <p>
                      A bit-field that is used to specify migration options. The table below
                      describes the possible values for flags.
                    </p>
              <div class="informaltable">
                <table border="1">
                  <colgroup>
                    <col align="left" class="col1" />
                    <col align="left" class="col2" />
                  </colgroup>
                  <thead>
                    <tr>
                      <th align="left">cl_mem_migration flags</th>
                      <th align="left">Description</th>
                    </tr>
                  </thead>
                  <tbody>
                    <tr>
                      <td align="left">
                        <code class="constant">CL_MIGRATE_MEM_OBJECT_HOST</code>
                      </td>
                      <td align="left">
                                  This flag indicates that the specified set of memory objects
                                  are to be migrated to the host, regardless of the target
                                  command-queue.
                                </td>
                    </tr>
                    <tr>
                      <td align="left">
                        <code class="constant">CL_MIGRATE_MEM_OBJECT_-
CONTENT_UNDEFINED</code>
                      </td>
                      <td align="left">
                                  This flag indicates that the contents of the set of memory
                                  objects are undefined after migration.  The specified set
                                  of memory objects are migrated to the device associated with
                                  <code class="varname">command_queue</code> without incurring the overhead
                                  of migrating their contents.
                                </td>
                    </tr>
                  </tbody>
                </table>
              </div>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname">
                        event_wait_list, num_events_in_wait_list
                    </code>
                </span>
            </dt>
            <dd>
              <p>
                      Specify events that need to complete before this particular
                      command can be executed.  If <code class="varname">event_wait_list</code>
                      is NULL, then this particular command does not wait on any
                      event to complete.  If <code class="varname">event_wait_list</code> is
                      NULL, <code class="varname">num_events_in_wait_list</code> must be 0. If
                      <code class="varname">event_wait_list</code> is not NULL, the list of events
                      pointed to by <code class="varname">event_wait_list</code> must be valid
                      and <code class="varname">num_events_in_wait_list</code> must be greater
                      than 0. The events specified in <code class="varname">event_wait_list</code>
                      act as synchronization points. The context associated with events in
                      <code class="varname">event_wait_list</code> and <code class="varname">command_queue</code> must
                      be the same. The memory associated with <code class="varname">event_wait_list</code>
                      can be reused or freed after the function returns.
                    </p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname">
                        event
                    </code>
                </span>
            </dt>
            <dd>
              <p>
                      Returns an event object that identifies this particular command and
                      can be used to query or queue a wait for this particular command
                      to complete. <code class="varname">event</code> can be NULL in which case
                      it will not be possible for the application to query the status of
                      this command or queue a wait for this command to complete.  If the
                      <code class="varname">event_wait_list</code> and the <code class="varname">event</code>
                      arguments are not NULL, the <code class="varname">event</code> argument should not
                      refer to an element of the <code class="varname">event_wait_list</code> array.
                    </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1">
        <a id="notes"></a>
        <h2>Notes</h2>
        <p>
            This section describes a mechanism for assigning which device an OpenCL memory object
            resides. A user may wish to have more explicit control over the location of their memory objects
            on creation. This could be used to:

            </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem" style="list-style-type: disc">Ensure that an object is allocated on a specific device prior to usage.</li>
            <li class="listitem" style="list-style-type: disc">Preemptively migrate an object from one device to another.</li>
          </ul>
        </div>
        <p>
        </p>
        <p>
          Typically, memory objects are implicitly migrated to a device
          for which enqueued commands, using the memory object, are targeted.
          <code class="function">clEnqueueMigrateMemObjects</code> allows this migration to be explicitly
          performed ahead of the dependent commands. This allows a user to preemptively change
          the association of a memory object, through regular command queue scheduling, in
          order to prepare for another upcoming command. This also permits an application to
          overlap the placement of memory objects with other unrelated operations before
          these memory objects are needed potentially hiding transfer latencies. Once
          the event, returned from <code class="function">clEnqueueMigrateMemObjects</code>,
          has been marked <code class="constant">CL_COMPLETE</code> the memory objects specified
          in <code class="varname">mem_objects</code> have been successfully migrated to the device
          associated with <code class="varname">command_queue</code>.  The migrated memory object shall
          remain resident on the device until another command is enqueued that either implicitly
          or explicitly migrates it away.
        </p>
        <p>
          <code class="function">clEnqueueMigrateMemObjects</code> can also be used to direct the initial
          placement of a memory object, after creation, possibly avoiding the initial overhead
          of instantiating the object on the first enqueued command to use it.
        </p>
        <p>
          The user is responsible for managing the event dependencies, associated with this
          command, in order to avoid overlapping access to memory objects. Improperly specified
          event dependencies passed to <code class="function">clEnqueueMigrateMemObjects</code> could
          result in undefined results.
        </p>
      </div>
      <div class="refsect1">
        <a id="errors"></a>
        <h2>Errors</h2>
        <p>
          <code class="function">clEnqueueMigrateMemObjects</code> returns <span class="errorname">CL_SUCCESS</span>
          if the function is executed successfully. Otherwise, it returns one of the following
          errors:
        </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_COMMAND_QUEUE</span> if <code class="varname">command_queue</code>
              is not a valid <code class="varname">command_queue</code>.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_CONTEXT</span> if the context associated with
              <code class="varname">command_queue</code> and memory objects in <code class="varname">memobj</code>
              are not the same or if the context associated with <code class="varname">command_queue</code>
              and events in <code class="varname">event_wait_list</code> are not the same.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_MEM_OBJECT</span> if any of the memory objects in
                <code class="varname">mem_objs</code> is not a valid memory object.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">num_mem_objects</code>
                is zero or if <code class="varname">mem_objects</code> is NULL.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_VALUE</span> if <code class="varname">flags</code> is
                not 0 or is not any of the values described in the table above.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_INVALID_EVENT_WAIT_LIST</span>
              if <code class="varname">event_wait_list</code> is NULL and
              <code class="varname">num_events_in_wait_list</code> &gt; 0,
              or <code class="varname">event_wait_list</code> is not NULL and
              <code class="varname">num_events_in_wait_list</code> is 0, or if event objects in
              <code class="varname">event_wait_list</code> are not valid events.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_MEM_OBJECT_ALLOCATION_FAILURE</span> if there is a
              failure to allocate memory for the specified set of memory objects in
              <code class="varname">mem_objects</code>.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_RESOURCES</span> if there is a failure to allocate
              resources required by the OpenCL implementation on the device.
            </li>
            <li class="listitem" style="list-style-type: disc"><span class="errorname">CL_OUT_OF_HOST_MEMORY</span> if there is a failure to allocate
              resources required by the OpenCL implementation on the host.
            </li>
          </ul>
        </div>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />

            <a href="http://www.khronos.org/registry/cl/specs/opencl-1.2.pdf#page=123" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="clEnqueueMapBuffer.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapBuffer</span></span></a>,
            <a class="citerefentry" href="clEnqueueMapImage.html"><span class="citerefentry"><span class="refentrytitle">clEnqueueMapImage</span></span></a>
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2011 The Khronos Group Inc.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials.
</div>
    </div>
  </body>
</html>
